docs: overhaul README, move history to docs/history.md#4
Open
atlas-slash[bot] wants to merge 1 commit intomainfrom
Open
docs: overhaul README, move history to docs/history.md#4atlas-slash[bot] wants to merge 1 commit intomainfrom
atlas-slash[bot] wants to merge 1 commit intomainfrom
Conversation
- Rewrote README.md as the primary documentation hub with install, quick start, column types, index types, JSON fields, transactions, CLI usage, configuration reference, and testing instructions - Moved the "Why?" history essay from README to docs/history.md - Removed stale monorepo reference from docs/overview.md - Added links to all detailed doc pages from README Co-authored-by: Kevin Bai <kevin@joinslash.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.mdas the primary documentation hub — it now covers installation, quick start, column types, index types, JSON fields, transactions, CLI usage (qb generate/qb codegen), configuration reference (qb.config.ts), and testingREADME.mdtodocs/history.md— the content is preserved as-isdocs/overview.mdhad "(not relevant in the monorepo)" next to the install instructions which no longer applies since this is a public packageMotivation
The old README was thin (just a link to docs + the history essay) and contained references to the monorepo. Now that this is a public package, the README should be the main entry point with all key information.